/*
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * RSVisualScene.h
 *
 *  Created on: 2010/03/04
 *      Author: Alexandre Pires ( c.alexandre.pires@gmail.com )
 */

#ifndef RSVISUALSCENE_H_
#define RSVISUALSCENE_H_

#include "RSUIDElement.h"

namespace Realsphere {

    class RSVisualScene: public Realsphere::RSUIDElement {
        Q_OBJECT
        Q_PROPERTY ( QString _attr_name READ Name WRITE SetName )
        public:
            RSVisualScene ( const QString& rId = QString::null,
                            const QString& rName = QString::null );
            virtual ~RSVisualScene ();

        public:
            RSNodeBase*             GetNode ( const QString& rId ) const;
            RSNodeBase*             GetNode ( unsigned int rIndex ) const;
            int                     IndexOf ( RSNodeBase* rNodeBase );
            unsigned int            NodesSize ( bool recursive = false );
            RSNodes                 Nodes () const;
            RSNodesIterator         NodesIterator () const;
            bool                    IsRootElement () const;

        public slots:
            RSError                 AddNode ( RSNodeBase* rNodeBase );
            RSError                 RemoveNode ( RSNodeBase* rNodeBase );
            RSError                 RemoveNode ( const QString& rId );
            RSError                 RemoveNode ( unsigned int rIndex );


        signals:
            void                    NodeAdded ( RSNodeBase* rNodeBase );
            void                    NodeRemoved ( RSNodeBase* rNodeBase );

        protected:
            RSError                 BeforeAddChildElement ( RSElement* rChild );
            bool                    AfterAddChildElement ( RSElement* rChild );
            bool                    AfterRemoveChildElement ( RSElement* rChild );

        private:
            RSNodes                 mNodes;
    };

}

#endif /* RSVISUALSCENE_H_ */
